Favicon

You are here: Home > API Reference > Windows > Windows Commands > Create winCommand

Create winCommand

Create winCommand

POST
/v1/organizations/:organizationId/mdm/windows/enterprise/devices/:winDeviceId/commands/
Copy to clipboard

Create winCommand

Create winCommand

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Entity Id or Slug
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
winDeviceId string
required
Entity Id, IMEI or Serial Number
Match pattern: ^(([a-fA-F0-9]{24})|(\w{1,}))$
Body Params application/json
commands array [object] optional
config object required
path string required
≤ 500 characters
action string required
Add Copy Delete Exec Get Replace
value string optional
≤ 500 characters
format string required
b64 bin bool chr int node null xml date time float
{
    "commands": [
        {
            "config": {
                "path": "string",
                "action": "Add",
                "value": "string",
                "format": "b64"
            }
        }
    ]
}

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
admEnterpriseId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
winDeviceId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
mdmUserId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
cmdId string optional
≤ 128 characters
status string optional
Pending Awaiting UnexpectedError Acknowledged Cancel MethodNotAllowed Unknown Unauthorized CommandFormatError CommandNotFound NotSupported DeleteWithoutArchive ItemNotDeleted AuthenticationAccepted ChunkedItemAcceptedAndBuffered OperationCanceled CommandNotExecutedUserCanceled CommandInsideAtomicElementAndAtomicFailed RequestedTargetIsOneOfMultipleAlternativesRequestedTarget RequestedTargetHasANewURI RequestedTargetMovedToADifferentURI RequestedTargetCanBeFoundAtAnotherURI RequestedSyncMLCommandNotExecutedOnTarget RequestedTargetMustBeAccessedThroughSpecifiedProxyURI PaymentIsNeeded FailedByRecipientUnderstoodTheCommand InvalidOriginatorAuthentication ExpectedMessageNotReceivedInRequiredPeriodOfTime UpdateConflictBetweenClientAndServerVersion TargetNotLongerAvailable CommandMustBeAccompaniedByByteSizeOrLength IncompleteOrIncorrectFormed RequestItemTooLong TargetURIIsTooLong UnsupportedMediaType ByteSizeTooBig RequestFailRetryAfterSomeTime PutOrAddCommandFailedBecauseTargetAlreadyExists ConflictDetectedResolvedServerCommandWinning NoMoreStorageSpaceForRemainingSynchronizationData SpecifiedSearchGrammarWasNotKnown CGIScriptingInLocURIWasIncorrectlyFormed SoftDeletedItemAlreadyHardDeleted ChunkedObjectReceivedByIncorrectSizeDeclared InvalidAdequateAccessControlPermissions PartialItemNotAccepted ParentCanNotBeDeletedSinceItContainsChildren MoveFailed CommandNotSupported GatewayOrProxyError TemporaryOverloadingOrMaintenanceError GatewayOrProxyTimeout InvalidSyncMLDTDVersion ApplicationErrorWhileProcessingTheRequest ErrorCausedAllSyncMKCommandsFail ErrorARefreshSynchronizationIsNeeded ReservedForFutureUse ErrorInRecipientDataStore SevereErrorInServer ApplicationErrorDuringSynchronization SyncMLSynchronizationVersionNotSupported SyncMlCommandCanceled AtomicRollbackFailed AtomicResponseTooLarge MalformedSyntax
name string optional
≤ 500 characters
commands array [object] optional
cmdId string optional
≤ 128 characters
status object optional
Pending string optional
Pending
Awaiting string optional
Awaiting
UnexpectedError string optional
UnexpectedError
Acknowledged string optional
Acknowledged
Cancel string optional
Cancel
MethodNotAllowed string optional
MethodNotAllowed
Unknown string optional
Unknown
Unauthorized string optional
Unauthorized
CommandFormatError string optional
CommandFormatError
CommandNotFound string optional
CommandNotFound
NotSupported string optional
NotSupported
DeleteWithoutArchive string optional
DeleteWithoutArchive
ItemNotDeleted string optional
ItemNotDeleted
AuthenticationAccepted string optional
AuthenticationAccepted
ChunkedItemAcceptedAndBuffered string optional
ChunkedItemAcceptedAndBuffered
OperationCanceled string optional
OperationCanceled
CommandNotExecutedUserCanceled string optional
CommandNotExecutedUserCanceled
CommandInsideAtomicElementAndAtomicFailed string optional
CommandInsideAtomicElementAndAtomicFailed
RequestedTargetIsOneOfMultipleAlternativesRequestedTarget string optional
RequestedTargetIsOneOfMultipleAlternativesRequestedTarget
RequestedTargetHasANewURI string optional
RequestedTargetHasANewURI
RequestedTargetMovedToADifferentURI string optional
RequestedTargetMovedToADifferentURI
RequestedTargetCanBeFoundAtAnotherURI string optional
RequestedTargetCanBeFoundAtAnotherURI
RequestedSyncMLCommandNotExecutedOnTarget string optional
RequestedSyncMLCommandNotExecutedOnTarget
RequestedTargetMustBeAccessedThroughSpecifiedProxyURI string optional
RequestedTargetMustBeAccessedThroughSpecifiedProxyURI
PaymentIsNeeded string optional
PaymentIsNeeded
FailedByRecipientUnderstoodTheCommand string optional
FailedByRecipientUnderstoodTheCommand
InvalidOriginatorAuthentication string optional
InvalidOriginatorAuthentication
ExpectedMessageNotReceivedInRequiredPeriodOfTime string optional
ExpectedMessageNotReceivedInRequiredPeriodOfTime
UpdateConflictBetweenClientAndServerVersion string optional
UpdateConflictBetweenClientAndServerVersion
TargetNotLongerAvailable string optional
TargetNotLongerAvailable
CommandMustBeAccompaniedByByteSizeOrLength string optional
CommandMustBeAccompaniedByByteSizeOrLength
IncompleteOrIncorrectFormed string optional
IncompleteOrIncorrectFormed
RequestItemTooLong string optional
RequestItemTooLong
TargetURIIsTooLong string optional
TargetURIIsTooLong
UnsupportedMediaType string optional
UnsupportedMediaType
ByteSizeTooBig string optional
ByteSizeTooBig
RequestFailRetryAfterSomeTime string optional
RequestFailRetryAfterSomeTime
PutOrAddCommandFailedBecauseTargetAlreadyExists string optional
PutOrAddCommandFailedBecauseTargetAlreadyExists
ConflictDetectedResolvedServerCommandWinning string optional
ConflictDetectedResolvedServerCommandWinning
NoMoreStorageSpaceForRemainingSynchronizationData string optional
NoMoreStorageSpaceForRemainingSynchronizationData
SpecifiedSearchGrammarWasNotKnown string optional
SpecifiedSearchGrammarWasNotKnown
CGIScriptingInLocURIWasIncorrectlyFormed string optional
CGIScriptingInLocURIWasIncorrectlyFormed
SoftDeletedItemAlreadyHardDeleted string optional
SoftDeletedItemAlreadyHardDeleted
ChunkedObjectReceivedByIncorrectSizeDeclared string optional
ChunkedObjectReceivedByIncorrectSizeDeclared
InvalidAdequateAccessControlPermissions string optional
InvalidAdequateAccessControlPermissions
PartialItemNotAccepted string optional
PartialItemNotAccepted
ParentCanNotBeDeletedSinceItContainsChildren string optional
ParentCanNotBeDeletedSinceItContainsChildren
MoveFailed string optional
MoveFailed
CommandNotSupported string optional
CommandNotSupported
GatewayOrProxyError string optional
GatewayOrProxyError
TemporaryOverloadingOrMaintenanceError string optional
TemporaryOverloadingOrMaintenanceError
GatewayOrProxyTimeout string optional
GatewayOrProxyTimeout
InvalidSyncMLDTDVersion string optional
InvalidSyncMLDTDVersion
ApplicationErrorWhileProcessingTheRequest string optional
ApplicationErrorWhileProcessingTheRequest
ErrorCausedAllSyncMKCommandsFail string optional
ErrorCausedAllSyncMKCommandsFail
ErrorARefreshSynchronizationIsNeeded string optional
ErrorARefreshSynchronizationIsNeeded
ReservedForFutureUse string optional
ReservedForFutureUse
ErrorInRecipientDataStore string optional
ErrorInRecipientDataStore
SevereErrorInServer string optional
SevereErrorInServer
ApplicationErrorDuringSynchronization string optional
ApplicationErrorDuringSynchronization
SyncMLSynchronizationVersionNotSupported string optional
SyncMLSynchronizationVersionNotSupported
SyncMlCommandCanceled string optional
SyncMlCommandCanceled
AtomicRollbackFailed string optional
AtomicRollbackFailed
AtomicResponseTooLarge string optional
AtomicResponseTooLarge
MalformedSyntax string optional
MalformedSyntax
config object optional
path string optional
≤ 500 characters
action object optional
Add string optional
Add
Copy string optional
Copy
Delete string optional
Delete
Exec string optional
Exec
Get string optional
Get
Replace string optional
Replace
value string optional
≤ 500 characters
format object optional
b64 string optional
b64
bin string optional
bin
bool string optional
bool
chr string optional
chr
int string optional
int
node string optional
node
null string optional
null
xml string optional
xml
date string optional
date
time string optional
time
float string optional
float
revision string optional
≤ 500 characters
data array [object] optional
statusCode integer optional
≥ 0
sentAt string optional
Format: date-time
receivedAt string optional
Format: date-time
canceledAt string optional
Format: date-time
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
{
    "status": true,
    "data": {
        "id": "string",
        "organizationId": "string",
        "admEnterpriseId": "string",
        "winDeviceId": "string",
        "mdmUserId": "string",
        "cmdId": "string",
        "status": "Pending",
        "name": "string",
        "commands": [
            {
                "cmdId": "string",
                "status": {
                    "Pending": "Pending",
                    "Awaiting": "Awaiting",
                    "UnexpectedError": "UnexpectedError",
                    "Acknowledged": "Acknowledged",
                    "Cancel": "Cancel",
                    "MethodNotAllowed": "MethodNotAllowed",
                    "Unknown": "Unknown",
                    "Unauthorized": "Unauthorized",
                    "CommandFormatError": "CommandFormatError",
                    "CommandNotFound": "CommandNotFound",
                    "NotSupported": "NotSupported",
                    "DeleteWithoutArchive": "DeleteWithoutArchive",
                    "ItemNotDeleted": "ItemNotDeleted",
                    "AuthenticationAccepted": "AuthenticationAccepted",
                    "ChunkedItemAcceptedAndBuffered": "ChunkedItemAcceptedAndBuffered",
                    "OperationCanceled": "OperationCanceled",
                    "CommandNotExecutedUserCanceled": "CommandNotExecutedUserCanceled",
                    "CommandInsideAtomicElementAndAtomicFailed": "CommandInsideAtomicElementAndAtomicFailed",
                    "RequestedTargetIsOneOfMultipleAlternativesRequestedTarget": "RequestedTargetIsOneOfMultipleAlternativesRequestedTarget",
                    "RequestedTargetHasANewURI": "RequestedTargetHasANewURI",
                    "RequestedTargetMovedToADifferentURI": "RequestedTargetMovedToADifferentURI",
                    "RequestedTargetCanBeFoundAtAnotherURI": "RequestedTargetCanBeFoundAtAnotherURI",
                    "RequestedSyncMLCommandNotExecutedOnTarget": "RequestedSyncMLCommandNotExecutedOnTarget",
                    "RequestedTargetMustBeAccessedThroughSpecifiedProxyURI": "RequestedTargetMustBeAccessedThroughSpecifiedProxyURI",
                    "PaymentIsNeeded": "PaymentIsNeeded",
                    "FailedByRecipientUnderstoodTheCommand": "FailedByRecipientUnderstoodTheCommand",
                    "InvalidOriginatorAuthentication": "InvalidOriginatorAuthentication",
                    "ExpectedMessageNotReceivedInRequiredPeriodOfTime": "ExpectedMessageNotReceivedInRequiredPeriodOfTime",
                    "UpdateConflictBetweenClientAndServerVersion": "UpdateConflictBetweenClientAndServerVersion",
                    "TargetNotLongerAvailable": "TargetNotLongerAvailable",
                    "CommandMustBeAccompaniedByByteSizeOrLength": "CommandMustBeAccompaniedByByteSizeOrLength",
                    "IncompleteOrIncorrectFormed": "IncompleteOrIncorrectFormed",
                    "RequestItemTooLong": "RequestItemTooLong",
                    "TargetURIIsTooLong": "TargetURIIsTooLong",
                    "UnsupportedMediaType": "UnsupportedMediaType",
                    "ByteSizeTooBig": "ByteSizeTooBig",
                    "RequestFailRetryAfterSomeTime": "RequestFailRetryAfterSomeTime",
                    "PutOrAddCommandFailedBecauseTargetAlreadyExists": "PutOrAddCommandFailedBecauseTargetAlreadyExists",
                    "ConflictDetectedResolvedServerCommandWinning": "ConflictDetectedResolvedServerCommandWinning",
                    "NoMoreStorageSpaceForRemainingSynchronizationData": "NoMoreStorageSpaceForRemainingSynchronizationData",
                    "SpecifiedSearchGrammarWasNotKnown": "SpecifiedSearchGrammarWasNotKnown",
                    "CGIScriptingInLocURIWasIncorrectlyFormed": "CGIScriptingInLocURIWasIncorrectlyFormed",
                    "SoftDeletedItemAlreadyHardDeleted": "SoftDeletedItemAlreadyHardDeleted",
                    "ChunkedObjectReceivedByIncorrectSizeDeclared": "ChunkedObjectReceivedByIncorrectSizeDeclared",
                    "InvalidAdequateAccessControlPermissions": "InvalidAdequateAccessControlPermissions",
                    "PartialItemNotAccepted": "PartialItemNotAccepted",
                    "ParentCanNotBeDeletedSinceItContainsChildren": "ParentCanNotBeDeletedSinceItContainsChildren",
                    "MoveFailed": "MoveFailed",
                    "CommandNotSupported": "CommandNotSupported",
                    "GatewayOrProxyError": "GatewayOrProxyError",
                    "TemporaryOverloadingOrMaintenanceError": "TemporaryOverloadingOrMaintenanceError",
                    "GatewayOrProxyTimeout": "GatewayOrProxyTimeout",
                    "InvalidSyncMLDTDVersion": "InvalidSyncMLDTDVersion",
                    "ApplicationErrorWhileProcessingTheRequest": "ApplicationErrorWhileProcessingTheRequest",
                    "ErrorCausedAllSyncMKCommandsFail": "ErrorCausedAllSyncMKCommandsFail",
                    "ErrorARefreshSynchronizationIsNeeded": "ErrorARefreshSynchronizationIsNeeded",
                    "ReservedForFutureUse": "ReservedForFutureUse",
                    "ErrorInRecipientDataStore": "ErrorInRecipientDataStore",
                    "SevereErrorInServer": "SevereErrorInServer",
                    "ApplicationErrorDuringSynchronization": "ApplicationErrorDuringSynchronization",
                    "SyncMLSynchronizationVersionNotSupported": "SyncMLSynchronizationVersionNotSupported",
                    "SyncMlCommandCanceled": "SyncMlCommandCanceled",
                    "AtomicRollbackFailed": "AtomicRollbackFailed",
                    "AtomicResponseTooLarge": "AtomicResponseTooLarge",
                    "MalformedSyntax": "MalformedSyntax"
                },
                "config": {
                    "path": "string",
                    "action": {
                        "Add": "Add",
                        "Copy": "Copy",
                        "Delete": "Delete",
                        "Exec": "Exec",
                        "Get": "Get",
                        "Replace": "Replace"
                    },
                    "value": "string",
                    "format": {
                        "b64": "b64",
                        "bin": "bin",
                        "bool": "bool",
                        "chr": "chr",
                        "int": "int",
                        "node": "node",
                        "null": "null",
                        "xml": "xml",
                        "date": "date",
                        "time": "time",
                        "float": "float"
                    },
                    "revision": "string"
                },
                "data": [
                    {}
                ],
                "statusCode": 0,
                "sentAt": "2024-01-01T00: 00:00Z",
                "receivedAt": "2024-01-01T00: 00:00Z",
                "canceledAt": "2024-01-01T00: 00:00Z"
            }
        ],
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z"
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5091
message string optional
Invalid data
{
    "status": false,
    "error": {
        "code": 5091,
        "message": "Invalid data"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}